/*
 *  Licensed to the Apache Software Foundation (ASF) under one or more
 *  contributor license agreements.  See the NOTICE file distributed with
 *  this work for additional information regarding copyright ownership.
 *  The ASF licenses this file to You under the Apache License, Version 2.0
 *  (the "License"); you may not use this file except in compliance with
 *  the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 */
using System;

namespace org.apache.commons.compress.archivers.zip {

    /**
     * Info-ZIP Unicode Comment Extra Field (0x6375):
     *
     * <p>Stores the UTF-8 version of the file comment as stored in the
     * central directory header.</p>
     *
     * <pre>
     *         Value         Size        Description
     *         -----         ----        -----------
     *  (UCom) 0x6375        Short       tag for this extra block type ("uc")
     *         TSize         Short       total data size for this block
     *         Version       1 byte      version of this extra field, currently 1
     *         ComCRC32      4 bytes     Comment Field CRC32 Checksum
     *         UnicodeCom    Variable    UTF-8 version of the entry comment
     * </pre>
     * @NotThreadSafe super-class is not thread-safe
     */
    public class UnicodeCommentExtraField : AbstractUnicodeExtraField {

        public static readonly ZipShort UCOM_ID = new ZipShort(0x6375);

        public UnicodeCommentExtraField () { 
        }

        /**
         * Assemble as unicode comment extension from the name given as
         * text as well as the encoded bytes actually written to the archive.
         * 
         * @param text The file name
         * @param bytes the bytes actually written to the archive
         * @param off The offset of the encoded comment in <code>bytes</code>.
         * @param len The length of the encoded comment or comment in
         * <code>bytes</code>.
         */
        public UnicodeCommentExtraField(String text, byte[] bytes, int off,int len) : base (text,bytes,off,len) {
        }

        /**
         * Assemble as unicode comment extension from the comment given as
         * text as well as the bytes actually written to the archive.
         * 
         * @param comment The file comment
         * @param bytes the bytes actually written to the archive
         */
        public UnicodeCommentExtraField(String comment, byte[] bytes) : base (comment, bytes) {
        }

        /** {@inheritDoc} */
        public override ZipShort getHeaderId() {
            return UCOM_ID;
        }

    }
}